/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.server.services.security;

import java.util.Map;

import org.jboss.as.controller.VaultReader;

/**
 *
 * @author <a href="kabir.khan@jboss.com">Kabir Khan</a>
 */
public abstract class AbstractVaultReader implements VaultReader {

    /**
     * Creates and initialises a vault, loading it from the PicketLink module
     * @deprecated Use {@link #createVault(String, String, Map)} instead
     * @param fqn the name of the vault class, may be null
     * @param options the vault options
     * @throws VaultReaderException
     */
    @Deprecated
    protected abstract void createVault(final String fqn, final Map<String, Object> options) throws VaultReaderException;

    /**
     *
     * @param fqn the name of the vault class, may be null
     * @param module the module to use to load the vault
     * @param options the vault options
     * @throws VaultReaderException
     */
    protected abstract void createVault(final String fqn, final String module, final Map<String, Object> options) throws VaultReaderException;

    protected abstract void destroyVault();
}
